data class EnhancementEstimate(val expectedQualityGain: Double, val estimatedLatencyMs: Long, val estimatedTokenCost: Int, val recommendation: EnhancementRecommendation)

EnhancementRecommendation

enum EnhancementRecommendation : Enum<EnhancementRecommendation>

EnhancementType

enum EnhancementType : Enum<EnhancementType>

EntityCluster

data class EntityCluster<E>(val anchor: E, val similar: List<<Error class: unknown class><E>>)

Cluster of similar entities

EntityData

interface EntityData : RetrievableEntity

Generic retrieved entity

ExplorationRequest

sealed interface ExplorationRequest

Fact

data class Fact(val assertion: String, val authority: String, val uri: String? = null, val metadata: Map<String, Any?> = emptyMap(), val id: String = UUID.randomUUID().toString()) : Source

A fact.

HierarchicalContentElement

interface HierarchicalContentElement : ContentElement

ContentElement that exists in a hierarchy, such as a document with sections and subsections.

LeafSection

data class LeafSection(val id: String, val uri: String? = null, val title: String, val text: String, val parentId: String? = null, val metadata: Map<String, Any?> = emptyMap()) : MaterializedSection, HasContent

Contains content

MappedEntity

interface MappedEntity : RetrievableEntity

Entity mapped with JPA, Neo OGM or another persistence tool. Will be a JVM object. What it exposes beyond RetrievableEntity methods is a matter for the RagService in the application. MappedEntity objects have their own distinct types and can expose

MaterializedSection

interface MaterializedSection : Section

NamedEntityData

interface NamedEntityData : EntityData

Adds a name to the well known entity data.

NavigableRagService

@ApiStatus.Experimental

interface NavigableRagService : RagService

Rag service that supports navigation in a graph of retrievable objects. This may not be supported by all RAG services. It need not be a graph but could be implemented by a relational database or other structure.

PathsExplorationRequest

data class PathsExplorationRequest(val paths: List<String>) : ExplorationRequest

QualityMetrics

data class QualityMetrics(val faithfulness: <Error class: unknown class>, val answerRelevancy: <Error class: unknown class>, val contextPrecision: <Error class: unknown class>, val contextRecall: <Error class: unknown class>, val contextRelevancy: <Error class: unknown class>, val overallScore: <Error class: unknown class> = computeRAGASScore( faithfulness, answerRelevancy, contextPrecision, contextRecall, contextRelevancy, ))

RAGAS quality metrics

RagRequest

data class RagRequest(val query: String, val similarityThreshold: <Error class: unknown class> = 0.8, val topK: Int = 8, val compressionConfig: CompressionConfig = CompressionConfig(), val labels: Set<String> = emptySet(), val timestamp: Instant = Instant.now()) : RagRequestRefinement

RAG request. Contains a query and parameters for similarity search.

RagRequestRefinement

interface RagRequestRefinement

Narrowing of RagRequest

RagResponse

data class RagResponse(val request: RagRequest, val service: String, val results: List<<Error class: unknown class><out Retrievable>>, val enhancement: RagResponseEnhancement? = null, val qualityMetrics: QualityMetrics? = null, val timestamp: Instant = Instant.now())

Rag response RagResponses can contain results from multiple RAG services. Results are not necessarily chunks, but can be entities.

RagResponseEnhancement

data class RagResponseEnhancement(val enhancer: RagResponseEnhancer, val basis: RagResponse, val processingTimeMs: Long = 0, val tokensProcessed: Int = 0, val enhancementType: EnhancementType, val qualityImpact: <Error class: unknown class>? = null)

RagResponseEnhancer

interface RagResponseEnhancer

RagResponseFormatter

fun interface RagResponseFormatter

Implemented by classes that can format RagResponse objects into a string for inclusion in tool responses or prompts.

RagService

interface RagService

Central interface for Retrieval-Augmented Generation (RAG) services. Returns entities as well as text chunks.

RagServiceEnhancer

interface RagServiceEnhancer

RagServiceEnhancerProperties

data class RagServiceEnhancerProperties(val compressionLlm: <Error class: unknown class> = LlmOptions.withAutoLlm(), val rerankingLlm: <Error class: unknown class> = LlmOptions.withAutoLlm(), val maxConcurrency: Int = 12)

RepositoryRagService

@ApiStatus.Experimental

interface RepositoryRagService : RagService

RagService comparable to a Spring Data repository.

Retrievable

interface Retrievable : ContentElement

A Retrievable object instance is a ContentElement (normally a chunk or an entity) that can be retrieved by RAG. It has a stable id.

RetrievableEntity

interface RetrievableEntity : Retrievable

Any retrievable entity, whether mapped or generic.

Section

sealed interface Section : HierarchicalContentElement

SimpleNamedEntityData

data class SimpleNamedEntityData(val id: String, val uri: String? = null, val name: String, val description: String, val labels: Set<String>, val properties: Map<String, Any>, val metadata: Map<String, Any?> = emptyMap()) : NamedEntityData

SimpleRagResponseFormatter

object SimpleRagResponseFormatter : RagResponseFormatter

Sensible default RagResponseFormatter

Source

sealed interface Source : Retrievable

A Source object instance is an input such as a Chunk or a Fact. It was provided to the system as data; it is not inferred by the system, but a direct piece of data.

Sourced

interface Sourced

Implemented by objects that are from a source.

WritableRagService

interface WritableRagService : RagService

RagService that can accept documents

Functions

computeRAGASScore

fun computeRAGASScore(faithfulness: Double, answerRelevancy: Double, contextPrecision: Double, contextRecall: Double, contextRelevancy: Double): Double